<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="SequenceBindingWaiter,net.digitalprimates.fluint.sequence.SequenceBindingWaiter,eventName,propertyName,target,timeout,timeoutHandler,setupListeners" name="keywords">
<title>net.digitalprimates.fluint.sequence.SequenceBindingWaiter</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'SequenceBindingWaiter - Fluint API';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?net/digitalprimates/fluint/sequence/SequenceBindingWaiter.html&amp;net/digitalprimates/fluint/sequence/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;SequenceBindingWaiter</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class SequenceBindingWaiter"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">net.digitalprimates.fluint.sequence</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class SequenceBindingWaiter</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implements</td><td><a href="ISequencePend.html">ISequencePend</a></td>
</tr>
</table>
<p></p> 
  The sequence setter class tells the TestCase instance to pend until 
  the eventName occurs or the timeout expires.
  <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#eventName">eventName</a> : String<div class="summaryTableDescription">[read-only] 
   Name of the event that will be broadcast by the target.</div>
</td><td class="summaryTableOwnerCol">SequenceBindingWaiter</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#propertyName">propertyName</a> : String<div class="summaryTableDescription">[read-only] 
   Name of the property that will change.</div>
</td><td class="summaryTableOwnerCol">SequenceBindingWaiter</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#target">target</a> : IEventDispatcher<div class="summaryTableDescription">[read-only] 
   The event dispatcher where the properties/value pairs defined 
   in the props object will be set.</div>
</td><td class="summaryTableOwnerCol">SequenceBindingWaiter</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#timeout">timeout</a> : int<div class="summaryTableDescription">[read-only] 
   The number of milliseconds this class should wait for its handleEvent 
   method to be called, before firing a 'timerExpired' event.</div>
</td><td class="summaryTableOwnerCol">SequenceBindingWaiter</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#timeoutHandler">timeoutHandler</a> : Function<div class="summaryTableDescription">[read-only] 
   A reference to the event handler that should be called if the event named in eventName  
   does not fire before the timeout is reached.</div>
</td><td class="summaryTableOwnerCol">SequenceBindingWaiter</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#SequenceBindingWaiter()">SequenceBindingWaiter</a>(target:IEventDispatcher, propertyName:String, timeout:int, timeoutHandler:Function = null)</div>
<div class="summaryTableDescription">
   Constructor.</div>
</td><td class="summaryTableOwnerCol">SequenceBindingWaiter</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setupListeners()">setupListeners</a>(testCase:<a href="../tests/TestCase.html">TestCase</a>, sequence:<a href="SequenceRunner.html">SequenceRunner</a>):void</div>
<div class="summaryTableDescription"> 
   Called by the SequenceRunner to cause the setup of event listeners
   </div>
</td><td class="summaryTableOwnerCol">SequenceBindingWaiter</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="eventName"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">eventName</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>eventName:String</code>&nbsp;&nbsp;[read-only]<p> 
   Name of the event that will be broadcast by the target. 
   
   When this event is broadcast, the TestCase sequence
   code moves onto the next step in the sequence. 
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get eventName():String</code>
<br>
</div>
<a name="propertyName"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">propertyName</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>propertyName:String</code>&nbsp;&nbsp;[read-only]<p> 
   Name of the property that will change. 
   
   When this property changes, the TestCase sequence
   code moves onto the next step in the sequence. 
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get propertyName():String</code>
<br>
</div>
<a name="target"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">target</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>target:IEventDispatcher</code>&nbsp;&nbsp;[read-only]<p> 
   The event dispatcher where the properties/value pairs defined 
   in the props object will be set. 
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get target():IEventDispatcher</code>
<br>
</div>
<a name="timeout"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">timeout</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>timeout:int</code>&nbsp;&nbsp;[read-only]<p> 
   The number of milliseconds this class should wait for its handleEvent 
   method to be called, before firing a 'timerExpired' event. 
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get timeout():int</code>
<br>
</div>
<a name="timeoutHandler"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">timeoutHandler</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>timeoutHandler:Function</code>&nbsp;&nbsp;[read-only]<p> 
   A reference to the event handler that should be called if the event named in eventName  
   does not fire before the timeout is reached. The handler is expected to have the follow signature:
   
   public function handleTimeoutEvent( passThroughData:Object ):void {
   }
   
   The parameter is a generic object that can optionally be provided by the developer when starting
   a new asynchronous operation.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get timeoutHandler():Function</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="SequenceBindingWaiter()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">SequenceBindingWaiter</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function SequenceBindingWaiter(target:IEventDispatcher, propertyName:String, timeout:int, timeoutHandler:Function = null)</code><p>
   Constructor.
    
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:IEventDispatcher</code> &mdash; The target where the property exists.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">propertyName</span>:String</code> &mdash; The name of the property that will change via data binding.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">timeout</span>:int</code> &mdash; The number of milliseconds to wait before calling the timoutHandler.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">timeoutHandler</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; Called if the timout is reached before the event is broadcast. 
   </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="setupListeners()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setupListeners</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function setupListeners(testCase:<a href="../tests/TestCase.html">TestCase</a>, sequence:<a href="SequenceRunner.html">SequenceRunner</a>):void</code><p> 
   Called by the SequenceRunner to cause the setup of event listeners
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">testCase</span>:<a href="../tests/TestCase.html">TestCase</a></code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">sequence</span>:<a href="SequenceRunner.html">SequenceRunner</a></code></td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
